# eric7.Plugins.PluginEricapi

Module implementing the Ericapi plugin.

### Global Attributes

__header__
error

### Classes

EricapiPlugin | Class implementing the Ericapi plugin.

### Functions

exeDisplayData | Public method to support the display of some executable info.

## EricapiPlugin

Class implementing the Ericapi plugin.

### Derived from

QObject

### Class Attributes

None

### Class Methods

None

### Methods

EricapiPlugin | Constructor
__doEricapi | Private slot to perform the eric7_api API generation.
__ericapiProcessFinished | Private slot to perform actions after the API data was generated.
__execDialogFinished | Private slot to handle the execution dialog being closed.
__initialize | Private slot to (re)initialize the plugin.
__projectShowMenu | Private slot called, when the the project menu or a submenu is about to be shown.
activate | Public method to activate this plugin.
deactivate | Public method to deactivate this plugin.

### Static Methods

None

#### EricapiPlugin (Constructor)

EricapiPlugin(ui)

Constructor

ui (UserInterface)
  reference to the user interface object

#### EricapiPlugin.__doEricapi

__doEricapi()

Private slot to perform the eric7_api API generation.

#### EricapiPlugin.__ericapiProcessFinished

__ericapiProcessFinished()

Private slot to perform actions after the API data was generated.

#### EricapiPlugin.__execDialogFinished

__execDialogFinished()

Private slot to handle the execution dialog being closed.

#### EricapiPlugin.__initialize

__initialize()

Private slot to (re)initialize the plugin.

#### EricapiPlugin.__projectShowMenu

__projectShowMenu(menuName, _menu)

Private slot called, when the the project menu or a submenu is about to be shown.

menuName (str)
  name of the menu to be shown
_menu (QMenu)
  reference to the menu (unused)

#### EricapiPlugin.activate

activate()

Public method to activate this plugin.

Return:
  tuple of None and activation status

Return Type:
  bool

#### EricapiPlugin.deactivate

deactivate()

Public method to deactivate this plugin.

Up

## exeDisplayData

exeDisplayData()

Public method to support the display of some executable info.

Return:
  dictionary containing the data to query the presence of the executable

Return Type:
  dict

Up